# Copyright (c) 2007 Chris Moyer http://coredumped.org
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish, dis-
# tribute, sublicense, and/or sell copies of the Software, and to permit
# persons to whom the Software is furnished to do so, subject to the fol-
# lowing conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

from rra import RRA

class Min(RRA):
	"""
	Takes the MIN of all points contained

	xff - The xfiles factor defines what part of a consolidation interval 
		may be made up from *UNKNOWN* data while the consolidated value is 
		still regarded as known. It is given as the ratio of allowed *UNKNOWN* 
		PDPs to the number of PDPs in the interval. Thus, it ranges from 
		0 to 1 (exclusive).

	steps - defines how many of these primary data points are used to 
		build a consolidated data point which then goes into the archive.

	rows - defines how many generations of data values are kept in an RRA.
	"""
	def __init__(self, xff, steps, rows):
		RRA.__init__(self,"MIN", "%d:%d:%d" % (xff,steps,rows) )


